Vcenter NamespaceManagement SupervisorServices CheckResult

The Vcenter NamespaceManagement SupervisorServices CheckResult schema defines the result of the validation checks on the content of a Supervisor Service version.

This schema was added in vSphere API 7.0.3.0.

JSON Example

{
    "status": "string",
    "content_type": "string",
    "vsphere_apps_check_result": {
        "supervisor_service": "string",
        "version": "string",
        "display_name": "string",
        "description": "string",
        "eula": "string"
    },
    "carvel_apps_check_result": {
        "supervisor_service": "string",
        "version": "string",
        "display_name": "string",
        "description": "string"
    },
    "warning_messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "error_messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ]
}

string

status

Required

Indicates if the provided content is valid.

For more information see: Vcenter NamespaceManagement SupervisorServices ValidationStatus.

This property was added in vSphere API 7.0.3.0.

string

content_type

Optional

The type of the provided content. When this content_type is Vcenter NamespaceManagement SupervisorServices Versions ContentType.CUSTOM_YAML, the status is always VALID because a custom format is not validated.

For more information see: Vcenter NamespaceManagement SupervisorServices Versions ContentType.

This property was added in vSphere API 7.0.3.0.

If missing or null, the content type cannot be determined from the provided content.

vsphere_apps_check_result

Optional

The information about the Supervisor Service version retrieved from the provided content as a result of validation checks if the content is in the vSphere application format.

This property was added in vSphere API 7.0.3.0.

If missing or null, the content is not in the vSphere application service format, or the status is INVALID.

carvel_apps_check_result

Optional

The information about the Supervisor Service version retrieved from the provided content as a result of validation checks if the content is in the Carvel application format.

This property was added in vSphere API 8.0.0.1.

If missing or null, the content is not in the Carvel application package format, or the status is INVALID.

array of Vapi Std LocalizableMessage

warning_messages

Optional

A list of messages indicating why the content was considered valid but contains information that should be reviewed closely.

This property was added in vSphere API 7.0.3.0.

This property is optional and it is only relevant when the value of status is Vcenter NamespaceManagement SupervisorServices ValidationStatus.VALID_WITH_WARNINGS.

array of Vapi Std LocalizableMessage

error_messages

Optional

A list of messages indicating why the content was considered invalid.

This property was added in vSphere API 7.0.3.0.

This property is optional and it is only relevant when the value of status is Vcenter NamespaceManagement SupervisorServices ValidationStatus.INVALID.

Returned By

Vcenter NamespaceManagement SupervisorServices checkContent